/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.bookkeeper.common.conf;

import org.apache.bookkeeper.common.annotation.InterfaceAudience.Public;

/**
 * Validator that validates configuration settings.
 */
@Public
public interface Validator {

    /**
     * Validates the configuration value.
     *
     * @param name name of the configuration setting
     * @param value value of the configuration setting
     * @return true if it is a valid value, otherwise false.
     */
    boolean validate(String name, Object value);

    /**
     * Return the documentation for a given validator.
     *
     * @return the documentation for a given validator
     */
    default String documentation() {
        return "";
    }

}
